/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.programrule;

import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import com.google.common.collect.Sets;
import java.util.Set;
import lombok.RequiredArgsConstructor;
import org.hisp.dhis.common.DxfNamespaces;

/**
 * @author Enrico Colasante
 */
@JacksonXmlRootElement(
    localName = "programRuleEvaluationEnvironment",
    namespace = DxfNamespaces.DXF_2_0)
@RequiredArgsConstructor
public enum ProgramRuleActionEvaluationEnvironment {
  WEB("web"),
  ANDROID("android");

  private final String value;

  public static ProgramRuleActionEvaluationEnvironment fromValue(String value) {
    for (ProgramRuleActionEvaluationEnvironment type :
        ProgramRuleActionEvaluationEnvironment.values()) {
      if (type.value.equalsIgnoreCase(value)) {
        return type;
      }
    }

    return null;
  }

  /**
   * By default, actions should be run in all environments, and its up to the client to decide which
   * actions are unsuited to be run or not.
   *
   * @return Default environments where the actions should be run
   */
  public static Set<ProgramRuleActionEvaluationEnvironment> getDefault() {
    return Sets.newHashSet(ProgramRuleActionEvaluationEnvironment.values());
  }
}
